Inside Macintosh: QuickDraw GX Objects /

Chapter 6 - Transform Objects / Transform Objects Reference

Functions / Getting and Setting the Clip

GXGetTransformClip

You can use the GXGetTransformClip function to retrieve the clip property of a transform object.

gxShape GXGetTransformClip(gxTransform source);

source

A reference to the transform object whose clip shape you want to determine.

function result

A reference to a newly created shape object that is a copy of the source transform's clip.

DESCRIPTION

The GXGetTransformClip function creates a new shape object, copies into it the geometry of the shape referenced in the clip property of the source transform, and returns a reference to the new shape as the function result.

Note that the returned shape object is a copy; you can alter it without affecting the clip property of the source transform. If you call this function and alter the clip shape it returns, you can then assign that changed clip shape back to the transform object by calling the GXSetTransformClip function.

SPECIAL CONSIDERATIONS

If no error occurs, the GXGetTransformClip function creates a shape object; you are responsible for disposing of that object when you no longer need it.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
transform_is_nil
parameter_is_nil	(debugging version)

SEE ALSO

For information about the clip property of transform objects, see "Clip" on page 6-7.

To change the information in the clip property of a transform object, use the GXSetTransformClip function, described next.

If you want to manipulate the clip property of a transform associated with a specific shape, you can use the GXGetShapeClip function, described on page 6-45, or the GXSetShapeClip function, described on page 6-46.